Skip to content

Conversation

@ChaitanyaD48
Copy link
Contributor

Description

This PR enhances the pushDerived function in route_planning.go to consider all single-shard routing scenarios, not just those using the engine.EqualUnique opcode.

IsSingleShard() method checks if a route is a single shard route by looking at its opcode. The method returns true for the following opcodes: Unsharded, DBA, Next, EqualUnique, and Reference.

Reference - vitess/go/vt/vtgate/engine/routing.go

func (code Opcode) IsSingleShard() bool {
	switch code {
	case Unsharded, DBA, Next, EqualUnique, Reference:
		return true
	}
	return false
}

Related Issue(s)

Fixes #18952

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

AI Disclosure

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 2, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Dec 2, 2025
@github-actions github-actions bot added this to the v24.0.0 milestone Dec 2, 2025
@arthurschreiber
Copy link
Member

Can you also add test cases that show the impact of this change?

@ChaitanyaD48
Copy link
Contributor Author

ChaitanyaD48 commented Dec 8, 2025

Can you also add test cases that show the impact of this change?

Hi @arthurschreiber
I’ve been testing a few scenarios to validate the impact of this change, and I think this testcase demonstrates the expected behavior -

[
  {
    "comment": "Derived table pushdown optimization",
    "query": "SELECT * FROM (SELECT DISTINCT col FROM user.ref WHERE col = 1 LIMIT 10) as sub",
    "plan": {
      "Type": "Passthrough",
      "QueryType": "SELECT",
      "Original": "SELECT * FROM (SELECT DISTINCT col FROM user.ref WHERE col = 1 LIMIT 10) as sub",
      "Instructions": {
        "OperatorType": "Route",
        "Variant": "Reference",
        "Keyspace": {
          "Name": "user",
          "Sharded": true
        },
        "FieldQuery": "select col from (select col from ref where 1 != 1) as sub where 1 != 1",
        "Query": "select col from (select distinct col from ref where col = 1 limit 10) as sub"
      },
      "TablesUsed": [
        "user.ref"
      ]
    }
  }
]

Properties of the query -

  • user.ref is a Reference table (replicated across shards)
  • Subquery contains LIMIT, making the operator non-mergeable thus !op.IsMergeable(ctx) condition becomes true.
  • Routing opcode is Reference, which is now recognized as single-shard thus !innerRoute.Routing.OpCode().IsSingleShard() condition becomes false

These are the test results in both scenarios

Previous Case (EqualUnique-only):

  • isMergeable = false
  • opcode = Reference
  • Pushdown is blocked, even though the route is actually single-shard
  • vtgate must perform DISTINCT + LIMIT

Output -
image

Refactored Case (using IsSharded):

  • IsSingleShard() = true for Reference variant
  • Pushdown is allowed
  • MySQL executes the entire subquery

Output -
image

What do you think?

@ChaitanyaD48
Copy link
Contributor Author

Hi @arthurschreiber just following up on my previous comment.
Let me know what do you think of the test case provided.
Thanks!

@arthurschreiber
Copy link
Member

@ChaitanyaD48 The test case makes sense to me. 👍

@ChaitanyaD48
Copy link
Contributor Author

ChaitanyaD48 commented Dec 18, 2025

Thanks! @arthurschreiber
I've added the test case to reference_cases.json

@github-actions
Copy link
Contributor

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Jan 18, 2026
@github-actions github-actions bot removed the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Jan 19, 2026
@arthurschreiber arthurschreiber added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTGate and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jan 19, 2026
@codecov
Copy link

codecov bot commented Jan 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.90%. Comparing base (4a3e6a3) to head (a0c21e3).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18974      +/-   ##
==========================================
- Coverage   69.91%   69.90%   -0.01%     
==========================================
  Files        1613     1613              
  Lines      216122   216124       +2     
==========================================
- Hits       151097   151086      -11     
- Misses      65025    65038      +13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: VTGate Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Performance: pushDerived should use IsSingleShard() check

2 participants